dxp-ux

(0 reviews)

GET - BalanceActionHistory - TMF654

/balanceActionHistory (GET)

1.This is implemented for PA Market.

2.This is to view list of their past recharge transactions.

URL

http://[localhost]:[port]/dxp-ux/v1/{businessId}/balanceActionHistory

URL PARAMS

name	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)
businessId	string	2 letter ISO 3166 country code (PA) identifying the business unit.	Y

Headers

name	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)
client_id	string	The client_id identifying the channel.	Y
client_secret	string	Password associated with the client_id.	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	Y

Query PARAMS

name	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)
receiverLogicalResource.id	string	Service number of the customer Example: 50776767879	Y
confirmationDate.gte	string	To retrieve the list of past recharge transactions that were performed after this date. Expected format : yyyy-MM-dd, Eg: 2021-09-16	N
confirmationDate.lte	string	To retrieve the list of past recharge transactions that were performed before this date. Expected format : yyyy-MM-dd, Eg: 2021-09-16	N
@type	string	Type of balance action history. Possible Value : TopupBalance	Y

Data Model - Response

field name	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)
paymentMethod	object	Link to the resource that holds information about the payment mean used to complete the operation.	Y
paymentMethod.id	string	Unique Identifier within the server for the payment method.	Y
confirmationDate	datetime	Date when the transaction was confirmed.	Y
description	string	Description of the recharge operation.	Y
voucher	string	Identifier for a voucher when the topup can be performed by this means.	N
status	string	Status of the payment.	Y
amount	object	An amount in a given unit.	Y
amount.units	string	Unit of amount	Y
amount.amount	number	A positive floating point number	Y
receiverLogicalResource	object	Reference to the LogicalResource	Y
receiverLogicalResource.id	string	Unique identifier to identify subscriber	Y
receiverLogicalResource.name	string	Name of the related entity	Y
channel	object	The channel to which the resource reference to.	N
channel.id	string	Unique identifier of a related entity.	N
channel.name	string	Name of the channel	N
@type	string	When sub-classing, this defines the sub-class entity name.	N

Key considerations

Please find the response in the following link - DXP-UX - GET BalanceActionHistory

PA Implementation:

- This is implemented for prepaid customers.
- The '@type' input query parameter should be "TopupBalance".
- The 'receiverLogicalResource.id' input query parameter should be provided with BU code(507). Example: 50769877689
- If the dates are not specified in queryParams, the API returns history of last seven days balance action history by default.
- If the query parameter startDate is provided, the endDate parameter must also be included, and vice versa.
- The Ericsson API's data recovery period is 90 days; however, it is recommended not to use a search period longer than 7 days, as a longer period may result in a slower response time from Ericsson API.